<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Logger</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Logger</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A logger class which registers appenders (any writable handle location  which can be fopen'ed) with a unique name for that log. The library will  write all incoming/outgoing SOAP XML to <var>SOAP_XML_LOG</var> and  all records of requests to <var>REQUEST_INFO_LOG</var>.</p>
<p class="description"><p>Currently, levels are only used as indicators (there is no filtering  mechanism as of yet).</p><p>A list of supported appenders (file handles) can be found here:  <a href="http://us2.php.net/manual/en/wrappers.php">http://us2.php.net/manual/en/wrappers.php</a></p></p>
		<p class="notes">
			Located in <a class="field" href="_Ads---Common---Util---Logger.php.html">/Ads/Common/Util/Logger.php</a> (line <span class="field">47</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
												<div class="var-title">
					static <span class="var-type">string</span>
					<a href="#$DEBUG" title="details" class="var-name">$DEBUG</a>
				</div>
																<div class="var-title">
					static <span class="var-type">string</span>
					<a href="#$ERROR" title="details" class="var-name">$ERROR</a>
				</div>
																<div class="var-title">
					static <span class="var-type">string</span>
					<a href="#$FATAL" title="details" class="var-name">$FATAL</a>
				</div>
																<div class="var-title">
					static <span class="var-type">string</span>
					<a href="#$INFO" title="details" class="var-name">$INFO</a>
				</div>
																<div class="var-title">
					static <span class="var-type">string</span>
					<a href="#$REQUEST_INFO_LOG" title="details" class="var-name">$REQUEST_INFO_LOG</a>
				</div>
																<div class="var-title">
					static <span class="var-type">string</span>
					<a href="#$SOAP_XML_LOG" title="details" class="var-name">$SOAP_XML_LOG</a>
				</div>
																<div class="var-title">
					static <span class="var-type">string</span>
					<a href="#$STD_ERR_STREAM" title="details" class="var-name">$STD_ERR_STREAM</a>
				</div>
																<div class="var-title">
					static <span class="var-type">string</span>
					<a href="#$STD_OUT_STREAM" title="details" class="var-name">$STD_OUT_STREAM</a>
				</div>
																																																																															</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
												<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#Log" title="details" class="method-name">Log</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$log</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$level</span> = <span class="var-default">NULL</span>])
									</div>
																<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#LogToFile" title="details" class="method-name">LogToFile</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$log</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$filePath</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#LogToStream" title="details" class="method-name">LogToStream</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$log</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$phpIoStream</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#SetLogLevel" title="details" class="method-name">SetLogLevel</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$log</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$level</span>)
									</div>
								
																																				</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$DEBUG" id="$DEBUG"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			static <span class="var-type">string</span>
			<span class="var-name">$DEBUG</span>
			 = <span class="var-default"> 'DEBUG'</span>			(line <span class="line-number">84</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">DEBUG level.</p>
	<ul class="tags">
				<li><span class="field">var:</span> the debug level</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$ERROR" id="$ERROR"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			static <span class="var-type">string</span>
			<span class="var-name">$ERROR</span>
			 = <span class="var-default"> 'ERROR'</span>			(line <span class="line-number">90</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ERROR level.</p>
	<ul class="tags">
				<li><span class="field">var:</span> the error level</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$FATAL" id="$FATAL"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			static <span class="var-type">string</span>
			<span class="var-name">$FATAL</span>
			 = <span class="var-default"> 'FATAL'</span>			(line <span class="line-number">96</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">FATAL level.</p>
	<ul class="tags">
				<li><span class="field">var:</span> the fatal level</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$INFO" id="$INFO"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			static <span class="var-type">string</span>
			<span class="var-name">$INFO</span>
			 = <span class="var-default"> 'INFO'</span>			(line <span class="line-number">78</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">INFO level.</p>
	<ul class="tags">
				<li><span class="field">var:</span> the info level</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$REQUEST_INFO_LOG" id="$REQUEST_INFO_LOG"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			static <span class="var-type">string</span>
			<span class="var-name">$REQUEST_INFO_LOG</span>
			 = <span class="var-default"> 'request_info'</span>			(line <span class="line-number">58</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Logs all information about requests.</p>
	<ul class="tags">
				<li><span class="field">var:</span> log for all information about requests</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$SOAP_XML_LOG" id="$SOAP_XML_LOG"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			static <span class="var-type">string</span>
			<span class="var-name">$SOAP_XML_LOG</span>
			 = <span class="var-default"> 'soap_xml'</span>			(line <span class="line-number">52</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Logs all incomming and outgoing SOAP XML.</p>
	<ul class="tags">
				<li><span class="field">var:</span> log for all incomming and outgoing SOAP XML</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$STD_ERR_STREAM" id="$STD_ERR_STREAM"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			static <span class="var-type">string</span>
			<span class="var-name">$STD_ERR_STREAM</span>
			 = <span class="var-default"> 'php://stderr'</span>			(line <span class="line-number">72</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Standard error stream for use with the LogToStream method.</p>
	<ul class="tags">
				<li><span class="field">var:</span> stream for stderr</li>
				<li><span class="field">see:</span> self::LogToStream()</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$STD_OUT_STREAM" id="$STD_OUT_STREAM"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			static <span class="var-type">string</span>
			<span class="var-name">$STD_OUT_STREAM</span>
			 = <span class="var-default"> 'php://stdout'</span>			(line <span class="line-number">65</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Standard out stream for use with the LogToStream method.</p>
	<ul class="tags">
				<li><span class="field">var:</span> stream for stdout</li>
				<li><span class="field">see:</span> self::LogToStream()</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodLog" id="Log"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method Log</span> (line <span class="line-number">170</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Logs a message to the log at a specific level.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">void</span>
		<span class="method-name">
			Log
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$log</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$message</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$level</span> = <span class="var-default">NULL</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$log</span><span class="var-description">: the unique name of the log</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$message</span><span class="var-description">: the message to write</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$level</span><span class="var-description">: the level at which to write the message</span>			</li>
				</ul>
		
			
	</div>
<a name="methodLogToFile" id="LogToFile"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method LogToFile</span> (line <span class="line-number">113</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Logs the given log to a file at the file path.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">void</span>
		<span class="method-name">
			LogToFile
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$log</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$filePath</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$log</span><span class="var-description">: the unique name of the log</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$filePath</span><span class="var-description">: the location of the file to append the log to</span>			</li>
				</ul>
		
			
	</div>
<a name="methodLogToStream" id="LogToStream"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method LogToStream</span> (line <span class="line-number">130</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Logs the given log to a stream represented by <var>$phpIoStream</var>. The  availble streams are listed here:</p>
<p class="description"><p><a href="http://us3.php.net/manual/en/wrappers.php.php">http://us3.php.net/manual/en/wrappers.php.php</a></p><p>The variables <var>$STD_OUT_STREAM</var> and <var>$STD_ERR_STREAM</var> are  provided for your convenience.</p></p>
	<ul class="tags">
				<li><span class="field">see:</span> self::$STD_OUT_STREAM</li>
				<li><span class="field">see:</span> self::$STD_ERR_STREAM</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">void</span>
		<span class="method-name">
			LogToStream
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$log</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$phpIoStream</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$log</span><span class="var-description">: the unique name of the log</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$phpIoStream</span><span class="var-description">: the php I/O stream of the form php://*</span>			</li>
				</ul>
		
			
	</div>
<a name="methodSetLogLevel" id="SetLogLevel"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method SetLogLevel</span> (line <span class="line-number">160</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the logging level for a given log. Only messages at that log level  or higher will be written to the log.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">void</span>
		<span class="method-name">
			SetLogLevel
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$log</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$level</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$log</span><span class="var-description">: the unique name of the log</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$level</span><span class="var-description">: the level to filter for</span>			</li>
				</ul>
		
			
	</div>

						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
	</p>
	</div></body>
</html>